From 6b52141bbc62a6377b48304cd60f5c5f3a7a14ac Mon Sep 17 00:00:00 2001
From: Ian Jackson <ian.jackson@eu.citrix.com>
Date: Mon, 6 Jul 2015 16:52:30 +0100
Subject: [PATCH] libxl: Provide doc comments for AO_GC and STATE_AO_GC

CC: Andrew Cooper <andrew.cooper3@citrix.com>
Signed-off-by: Ian Jackson <Ian.Jackson@eu.citrix.com>
Acked-by: Ian Campbell <ian.campbell@citrix.com>
---
 tools/libxl/libxl_internal.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/tools/libxl/libxl_internal.h b/tools/libxl/libxl_internal.h
index 7129aeeb8f..1ead0282dd 100644
--- a/tools/libxl/libxl_internal.h
+++ b/tools/libxl/libxl_internal.h
@@ -2067,9 +2067,22 @@ _hidden void libxl__egc_cleanup(libxl__egc *egc);
         (rc);                                                   \
     })
 
+
+/*
+ * Given, in scope,
+ *   libxl__ao *ao;
+ * produces, in scope,
+ *   libxl__gc *gc;
+ */
 #define AO_GC                                   \
     libxl__gc *const gc __attribute__((unused)) = &ao->gc
 
+/*
+ * void STATE_AO_GC(libxl__ao *ao_spec);
+ * // Produces, in scope:
+ *   libxl__ao *ao;  // set from ao_spec
+ *   libxl__gc *gc;
+ */
 #define STATE_AO_GC(op_ao)                      \
     libxl__ao *const ao = (op_ao);              \
     libxl__gc *const gc __attribute__((unused)) = libxl__ao_inprogress_gc(ao)
-- 
2.30.2